home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / wordproc / hyprsee.arj / HYPRHELP.HYP < prev    next >
Text File  |  1993-06-07  |  10KB  |  225 lines
  1. @All about HyperSee
  2.  
  3.  █▀▀▀▀█ █▀▀▀▀█  (C) 1990,3 Norman Newman        █▀▀▀▀▀▀▀▀▀█
  4.  ▀█  █▀ ▀█  █▀                                  █  █▀▀▀█  █
  5.   █  █   █  █  █▀█ █▀█ █▀▀▀▀▀█ █▀▀▀▀▀█ █▀▀▀▀▀▀█ █  █   ▀▀▀▀ █▀▀▀▀▀█ █▀▀▀▀▀█
  6.   █  ▀▀▀▀▀  █  █ █ █ █ █ █▀█ █ █ █▀▀▀▀ █ █▀▀█ █ █  ▀▀▀▀▀▀▀█ █ █▀▀▀▀ █ █▀▀▀▀
  7.   █  █▀▀▀█  █  █ ▀▀▀ █ █ ▀▀▀ █ █ ▀▀█   █ ▀▀▀▀ █ ▀▀▀▀▀▀▀█  █ █ ▀▀█   █ ▀▀█
  8.   █  █   █  █  ▀▀▀▀█ █ █ █▀▀▀▀ █ █▀▀   █ █▀█ █▀ █▀▀█   █  █ █ █▀▀   █ █▀▀
  9.  █▀  ▀█ █▀  ▀█ █▀▀▀▀ █ █ █     █ ▀▀▀▀█ █ █ █ ▀█ █  ▀▀▀▀▀  █ █ ▀▀▀▀█ █ ▀▀▀▀█
  10.  ▀▀▀▀▀▀ ▀▀▀▀▀▀ ▀▀▀▀▀▀▀ ▀▀▀     ▀▀▀▀▀▀▀ ▀▀▀ ▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀
  11.       <HyperSee>                              <Invocation>
  12.  
  13.       <Command line switches>                 <Online help>
  14.  
  15.       <Creating HyperSee documents>           <Using HyperSee>
  16.  
  17.       <Shelling to DOS>                       <Executable links>
  18.  
  19.       <Shareware support>                     <Disclaimer>
  20. @HyperSee
  21.  
  22.  HyperSee is a simple HyperText display tool. 'HyperText' has become a
  23.  buzzword in the last few years and is thus difficult to describe. Standard
  24.  written text, such as books and magazines, may be considered linear
  25.  display methods in that they are normally read them from beginning to end,
  26.  without jumping about. HyperText material, on the other hand, allows one
  27.  to read documents in a non-linear fashion starting perhaps with the
  28.  first page, jumping to the middle, then to the last or the page previous.
  29.  In a phrase HyperText, like RAM, is random-access.
  30.  
  31.  ╓────────────────────────────────────────────────────────────────────────╖
  32.  ║ There are numerous HyperText display tools available, each interpreting║
  33.  ║ the basic HyperText idea in different manners; HyperSee is my modest   ║
  34.  ║ interpretation of that idea.                                           ║
  35.  ╙────────────────────────────────────────────────────────────────────────╜
  36. @Invocation
  37.  
  38. In order to invoke HyperSee, simply type 'HyperSee' at the DOS prompt; you
  39. may tell HyperSee which document to read, by typing the name of the
  40. document file after 'HyperSee' and before pressing "ENTER", for example
  41. 'hypersee hyprhelp'.  If you don't supply the name of a HyperSee document,
  42. HyperSee will display for you all the .HYP files (the HyperSee extension),
  43. in the current directory, enabling you to choose one.
  44.  
  45. HyperSee will create an index file (extension .ndx) automatically; you may
  46. delete this file inbetween consultations, but as a result HyperSee will
  47. have to rebuild this file the next time you wish to consult the document,
  48. thus slightly delaying your consultation. Should HyperSee find that the
  49. date stamp on the .HYP file is later than the .NDX file, HyperSee will
  50. rebuild the index file, thus ensuring that it is always up to date.
  51.  
  52.    <Command line switches>
  53. @Command line switches
  54. There are several command line switches which you may invoke in order to
  55. change HyperSee to fit your preferences.  Any number of blanks may come
  56. between switches, but the letters comprising each switch (eg /S6F) must be
  57. without any blanks between them. The switches are case insensitive, and
  58. are as follows:
  59.  
  60.  '/Bhh' - set background screen colour to attribute hh
  61.  
  62.  '/Nhh' - set the normal screen colour to attribute hh
  63.  
  64.  '/Lhh' - set link colour to attribute hh
  65.  
  66.  '/Shh' - set link selected colour to attribute hh
  67.  
  68.  '/43'  - display 43 lines on an EGA, 50 lines on a VGA
  69.  
  70.  
  71.  'hh' is the colour attribute in hexadecimal form according to the
  72.  following scheme -
  73.  
  74.     0  black                      8  gray
  75.     1  blue                       9  light blue
  76.     2  green                      A  light green
  77.     3  cyan                       B  light cyan
  78.     4  red                        C  light red
  79.     5  magenta                    D  light magenta
  80.     6  brown                      E  yellow
  81.     7  white                      F  bright white
  82.  
  83.  The first letter represents the background colour (from 0 - 7), and the
  84.  second is the foreground colour (0 - F). For example, hypersee /S6F will
  85.  invoke the program with a 'selected' colour of bright white on a brown
  86.  background, whereas hypersee hyprhelp/43 will invoke HyperSee in 43-line
  87.  mode, displaying the HyprHelp file.
  88. @Online help
  89.  
  90. Should you forget how to use HyperSee whilst running the program, simply
  91. press F1; your current screen will be saved and the help screen will be
  92. displayed. Pressing any key will remove the help screen and restore your
  93. current screen.
  94.  
  95. @Creating HyperSee documents
  96.  
  97. A HyperSee document is a simple ASCII text file (although it may include
  98. as well 8-bit graphic characters or foreign letters), created by a
  99. programming editor or word processor in ASCII format. The file must have
  100. the extension .HYP.
  101.  
  102. There are three concepts which compose a HyperSee document - pages, links
  103. and keys.
  104.  
  105.      <Pages>                            <Links>
  106.  
  107.      <Keys>
  108. @Pages
  109.  
  110. A page is simply a collection of sentences; lines should be no longer than
  111. 76 characters (and will be truncated if longer). On one screen fit 18
  112. lines (assuming a 25-line display; an EGA is capable of displaying 36 lines
  113. and a VGA 43); if a page is longer than this, the remainder will not be
  114. displayed immediately, but will constitute another screen, which can be
  115. reached via a link.
  116.  
  117. HyperSee will automatically insert a link back to the opening page of the
  118. document, but you must ensure that third-level pages (like this page) have
  119. a link back to the page that called them. In this document, we have the
  120. following hierarchy -
  121.  
  122. 1st level:                 <All about HyperSee>
  123.                ┌───────────────────┼────────────────────┐           
  124. 2nd level: <Invocation>        <Online help>    <Creating HyperSee documents>
  125.                            ┌──────────────┬─────────────┤
  126. 3rd level:               <Pages>          <Links>         <Keys>
  127. @Links
  128.  
  129. Links are what embody the HyperText idea; in my implementation, these are
  130. keys to other pages embedded in the text of a specific page. Physically, a
  131. link is the key to another page, enclosed in angle brackets <<>>
  132. (DON'T CHOOSE THIS "KEY"!!!). For example, in order to get to here, the
  133. page whose key is 'Creating HyperSee documents' contained the link "Links".
  134. When you chose that link, HyperSee brought you here.
  135.  
  136. When creating links, all the words constituting the link must be on the
  137. same physical line. HyperSee does not check that the links that you define
  138. are valid - ie there is a page whose key is the same as the link. If you
  139. choose a non-valid link, the opening page of the document will be
  140. displayed.
  141.  
  142. You can also create <Executable links> which, when chosen, will execute a
  143. program with the name of that link. These links are differentiated from
  144. ordinary links by enclosing them with the barline character (shift \, ASCII
  145. 124).
  146.  
  147.    <Creating HyperSee documents>
  148. @Keys
  149.  
  150. Every page has a predefined key or title; this is the word or phrase which
  151. uniquely denotes each page. In your text, the key is preceded by an
  152. ampersand sign, eg @Main Menu. The ampersand should be in the first
  153. column of text; the rest of the line constitutes the key. A key may be at
  154. most forty letters long.
  155.  
  156. The current implementation enables 1300 keys to be created; this should be
  157. enough for most situations.
  158.  
  159.  
  160.    <Creating HyperSee documents>
  161. @Using HyperSee
  162.  
  163. After HyperSee has been loaded, the first page of the document will be
  164. displayed on the screen. Links are differentiated from normal text in that
  165. they appear in yellow letters as opposed to cyan. The current link appears
  166. on a brown background. On a mono screen, the colours will be different.
  167.  
  168. You can navigate through the links by pressing the arrow keys; 'PgUp' will
  169. take you to the first link on the screen, and 'PgDn' will take you to the
  170. last link (normally the main menu). If you have a mouse, you can move
  171. through the links simply by moving the mouse. Pressing 'ENTER' or the left
  172. mouse button will display the page corresponding to the current link.
  173. Pressing 'ESC' or the right mouse button will terminate this HyperSee
  174. session. Pressing 'F1' will display this help screen.
  175. @Shelling to DOS
  176.  
  177. HyperSee allows you to 'shell to DOS' - to run another program whilst
  178. HyperSee is suspended. Press F10 in order to shell to DOS. Be aware that
  179. HyperSee stays resident in memory (requiring about 32K), and so you may
  180. not be able to run programs which require a large amount of memory.
  181. @Executable links
  182.  
  183. If you have embedded in your document a link which is the name of an
  184. executable DOS program, choosing this link will suspend the execution of
  185. HyperSee, and will execute the chosen link. As HyperSee stays resident in
  186. memory (requiring about 32K), you may not be able to run programs which
  187. require a large amount of memory.
  188.  
  189. These links are differentiated from ordinary links by enclosing them with
  190. the barline character (shift \, ASCII 124).
  191.  
  192. This feature can be usely to implement a simple menu scheme (see the file
  193. 'menu.hyp').
  194.  
  195.    <Links>
  196. @Shareware support
  197.  
  198. HyperSee is a shareware product; this means that you are given license to
  199. try this program for a limited period (30 days) without registering.
  200. Should you decide to continue using this program, you are requested to
  201. register by sending a cheque for $25 to:
  202.  
  203.           Norman Newman
  204.           Kibbutz Tsor'a
  205.           M.P. Shimshon
  206.           ISRAEL 99705.
  207.           
  208. Registering this program will entitle you to free support, updates for a
  209. year and the Pascal source code (should you be so interested). Your
  210. contribution will help me continue and develop this program.
  211.  
  212. You may freely copy this program for others as long as it is distributed
  213. in its original form, with both files (HyperSee.com and Hyprhelp.hyp)
  214. intact.
  215. @Disclaimer
  216.  
  217. HyperSee is provided "as is" without warranty of any kind, either express
  218. or implied, including but not limited to, the implied warranties of
  219. merchantability and fitness for any particular purpose, with respect to
  220. this software and accompanying documentation.
  221.  
  222. In no event shall Norman Newman, the author of 'HyperSee' be liable for
  223. any damages arising from the use or misuse of this program. You have so
  224. been warned!
  225.